Skip to main content

Create STOP Payment

Creates a new STOP Payment as a Standing Order using the CreateStandingOrder method for an account to prevent ACH_IN_DEBIT transactions. Set channel to STOP_PAYMENTS and transactionType to ACH_IN_DEBIT.

Method: POST

{{URL}}/jsonrpc

Headers

NameValue
Content-Typeapplication/json

Example

Payload Parameters
ParameterDescription
validUntilDateString (MM/DD/YYYY)
Expiry date for the STOP payment instruction.
channelString
Must be set to "STOP_PAYMENTS" to indicate a STOP instruction.
transactionTypeString
Type of transaction to stop (e.g., "ACH_IN_DEBIT").
maxPerTransactionAmountInteger
Maximum allowed transaction amount before STOP is triggered.
originatorNameString
Name of the transaction initiator.
isOneTimeUseBoolean
Whether this STOP payment is a single-use action.
accountIdString
Account ID where the STOP Payment is being applied.

Body

{
"method": "SmartContractService.CreateStandingOrder",
"id": "1",
"params": {
"payload": {
"validUntilDate": "5/12/2025",
"channel": "STOP_PAYMENTS",
"transactionType": "ACH_IN_DEBIT",
"maxPerTransactionAmount": 100,
"originatorName": "AJ,lee",
"isOneTimeUse": true,
"accountId": "4032002"
},
"api": {
"credential": "{{cred}}",
"signature": "{{signature}}",
"apiKey": "{{ApiKey}}",
"keyId": "{{DeviceID}}"
}
}
}

Response: 200

Payload Parameters
ParameterDescription
idString
A unique identifier for the request
resultObject
Contains the result of the operation
result.IDString
A unique identifier for the newly created standing order
result.messageString
A message indicating the status of the operation (e.g., "Standing Order Created Successfully")
jsonrpcString
The version of the JSON-RPC protocol (e.g., "2.0")
{
"id": "1",
"result": {
"ID": "TK10000000000009003",
"message": "Standing Order Created Successfully"
},
"jsonrpc": "2.0"

}